Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a safeguard for Sharing post filter results. #41600

Merged
merged 5 commits into from
Feb 7, 2025
Merged

Add a safeguard for Sharing post filter results. #41600

merged 5 commits into from
Feb 7, 2025

Conversation

zinigor
Copy link
Member

@zinigor zinigor commented Feb 6, 2025

Fixes warnings caused by incorrectly filtered post objects returned from an apply_filters call:

PHP Warning:  Attempt to read property "ID" on int in /wordpress/plugins/jetpack/14.3/modules/sharedaddy/sharing-service.php on line 1050

Proposed changes:

  • Adds a check to make sure the post is an object and has a set ID property.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

N/A.

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

  • Here's the problem though - I believe it only works when Jetpack is installed as the only plugin from the family, and when a non-Gutenberg theme is activated.

@zinigor zinigor marked this pull request as ready for review February 6, 2025 14:02
@zinigor zinigor self-assigned this Feb 6, 2025
@zinigor zinigor requested a review from a team February 6, 2025 14:02
@zinigor zinigor added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 6, 2025
@github-actions github-actions bot added [Feature] Sharing Post sharing, sharing buttons [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Feb 6, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/sharing-safeguard-post branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/sharing-safeguard-post

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@zinigor
Copy link
Member Author

zinigor commented Feb 6, 2025

I have just realized that the $post variable is not filtered 🤦🏽‍♂️ . It probably makes sense to move the statement all the way to the top of the function to avoid all other processing.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
edited
Loading

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

jeherve
jeherve reviewed Feb 6, 2025
View reviewed changes
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this at the top of the function:

jetpack/projects/plugins/jetpack/modules/sharedaddy/sharing-service.php

Lines 963 to 965 in 11ca6bd

if ( empty( $post ) ) {
return $text;
}

What if we updated that check instead, and checked for $post instanceof WP_Post instead of checking for an object?

@jeherve jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] In Progress [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 6, 2025
@zinigor
Copy link
Member Author

zinigor commented Feb 7, 2025 •
edited
Loading

Thanks Jeremy! I have totally missed that check, amending it totally makes sense. Totally :D

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Feb 7, 2025
@zinigor zinigor merged commit f2c86e0 into trunk Feb 7, 2025
65 checks passed
@zinigor zinigor deleted the add/sharing-safeguard-post branch February 7, 2025 13:46
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeherve jeherve jeherve approved these changes

Assignees

@zinigor zinigor

Labels
[Feature] Sharing Post sharing, sharing buttons [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zinigor @jeherve